[docs] Move documentation to inline comments: GailTextUtil and GailMisc
authorJavier Jardón <jjardon@gnome.org>
Sun, 18 Apr 2010 17:40:17 +0000 (19:40 +0200)
committerJavier Jardón <jjardon@gnome.org>
Sun, 18 Apr 2010 17:46:29 +0000 (19:46 +0200)
docs/reference/libgail-util/tmpl/gail-libgail-util-unused.sgml [deleted file]
docs/reference/libgail-util/tmpl/gailmisc.sgml [deleted file]
docs/reference/libgail-util/tmpl/gailtextutil.sgml [deleted file]
modules/other/gail/libgail-util/gailmisc.c
modules/other/gail/libgail-util/gailtextutil.c

diff --git a/docs/reference/libgail-util/tmpl/gail-libgail-util-unused.sgml b/docs/reference/libgail-util/tmpl/gail-libgail-util-unused.sgml
deleted file mode 100644 (file)
index e69de29..0000000
diff --git a/docs/reference/libgail-util/tmpl/gailmisc.sgml b/docs/reference/libgail-util/tmpl/gailmisc.sgml
deleted file mode 100644 (file)
index 6cb5571..0000000
+++ /dev/null
@@ -1,125 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GailMisc
-
-<!-- ##### SECTION Short_Description ##### -->
-GailMisc is a set of utility functions which may be useful to implementors of
-Atk interfaces for custom widgets.
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-GailMisc is a set of utility function which are used in the implemementation
-of Atk interfaces for Gtk widgets. They may be useful to implementors of 
-Atk interfaces for custom widgets.
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### FUNCTION gail_misc_add_attribute ##### -->
-<para>
-
-</para>
-
-@attrib_set: 
-@attr: 
-@value: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gail_misc_layout_get_run_attributes ##### -->
-<para>
-
-</para>
-
-@attrib_set: 
-@layout: 
-@text: 
-@offset: 
-@start_offset: 
-@end_offset: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gail_misc_get_default_attributes ##### -->
-<para>
-
-</para>
-
-@attrib_set: 
-@layout: 
-@widget: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gail_misc_get_extents_from_pango_rectangle ##### -->
-<para>
-
-</para>
-
-@widget: 
-@char_rect: 
-@x_layout: 
-@y_layout: 
-@x: 
-@y: 
-@width: 
-@height: 
-@coords: 
-
-
-<!-- ##### FUNCTION gail_misc_get_index_at_point_in_layout ##### -->
-<para>
-
-</para>
-
-@widget: 
-@layout: 
-@x_layout: 
-@y_layout: 
-@x: 
-@y: 
-@coords: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gail_misc_get_origins ##### -->
-<para>
-
-</para>
-
-@widget: 
-@x_window: 
-@y_window: 
-@x_toplevel: 
-@y_toplevel: 
-
-
-<!-- ##### FUNCTION gail_misc_add_to_attr_set ##### -->
-<para>
-
-</para>
-
-@attrib_set: 
-@attrs: 
-@attr: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gail_misc_buffer_get_run_attributes ##### -->
-<para>
-
-</para>
-
-@buffer: 
-@offset: 
-@start_offset: 
-@end_offset: 
-@Returns: 
-
-
diff --git a/docs/reference/libgail-util/tmpl/gailtextutil.sgml b/docs/reference/libgail-util/tmpl/gailtextutil.sgml
deleted file mode 100644 (file)
index 8fb464f..0000000
+++ /dev/null
@@ -1,95 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GailTextUtil
-
-<!-- ##### SECTION Short_Description ##### -->
-GailTextUtil is a utility class which can be used to implement some of
-the AtkText functions for accessible objects which implement AtkText.
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-GailTextUtil is a utility class which can be used to implement the
-AtkText functions which get text for accessible objects which implement
-AtkText.
-
-In GAIL it is used by the accsesible objects for GnomeCanvasText, GtkEntry,
-GtkLabel, GtkCellRendererText and GtkTextview.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GailTextUtil ##### -->
-<para>
-The GailTextCell structure should not be accessed directly.
-
-</para>
-
-@parent: 
-@buffer: 
-
-<!-- ##### ENUM GailOffsetType ##### -->
-<para>
-
-</para>
-
-@GAIL_BEFORE_OFFSET: 
-@GAIL_AT_OFFSET: 
-@GAIL_AFTER_OFFSET: 
-
-<!-- ##### FUNCTION gail_text_util_new ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### FUNCTION gail_text_util_text_setup ##### -->
-<para>
-
-</para>
-
-@textutil: 
-@text: 
-
-
-<!-- ##### FUNCTION gail_text_util_buffer_setup ##### -->
-<para>
-
-</para>
-
-@textutil: 
-@buffer: 
-
-
-<!-- ##### FUNCTION gail_text_util_get_text ##### -->
-<para>
-
-</para>
-
-@textutil: 
-@layout: 
-@function: 
-@boundary_type: 
-@offset: 
-@start_offset: 
-@end_offset: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gail_text_util_get_substring ##### -->
-<para>
-
-</para>
-
-@textutil: 
-@start_pos: 
-@end_pos: 
-@Returns: 
-
-
index ade1288bb4c8b5f102b07d5bb435b697e945d156..81b13821996c5c022cd7b4dc9ba7aca2185b6feb 100644 (file)
  * code for AtkUtil - for that code, please see gail/gail.c.
  */
 
+/**
+ * SECTION:gailmisc
+ * @Short_description: GailMisc is a set of utility functions which may be
+ *   useful to implementors of Atk interfaces for custom widgets.
+ * @Title: GailMisc
+ *
+ * GailMisc is a set of utility function which are used in the implemementation
+ * of Atk interfaces for GTK+ widgets. They may be useful to implementors of
+ * Atk interfaces for custom widgets.
+ */
+
+
 /**
  * gail_misc_get_extents_from_pango_rectangle:
  * @widget: The widget that contains the PangoLayout, that contains
index 5ef7f69a0aed1bfc901823d80f7d6cc9ee432843..ecfd8ef78530f18921579215ccb42ae02f17816d 100644 (file)
 #include <stdlib.h>
 #include "gailtextutil.h"
 
+/**
+ * SECTION:gailtextutil
+ * @Short_description: GailTextUtil is a utility class which can be used to
+ *   implement some of the #AtkText functions for accessible objects
+ *   which implement #AtkText.
+ * @Title: GailTextUtil
+ *
+ * GailTextUtil is a utility class which can be used to implement the
+ * #AtkText functions which get text for accessible objects which implement
+ * #AtkText.
+ *
+ * In GAIL it is used by the accsesible objects for #GnomeCanvasText, #GtkEntry,
+ * #GtkLabel, #GtkCellRendererText and #GtkTextView.
+ */
+
 static void gail_text_util_class_init      (GailTextUtilClass *klass);
 
 static void gail_text_util_init            (GailTextUtil      *textutil);